home *** CD-ROM | disk | FTP | other *** search
/ Language/OS - Multiplatform Resource Library / LANGUAGE OS.iso / cpp_libs / linklist / source.lha / doc / lGetIndxNode.3 < prev    next >
Encoding:
Text File  |  1993-08-08  |  835 b   |  36 lines
  1. '.so tmac.clman
  2. .TH "lGetIndxNode"
  3. .IX lGetIndxNode
  4. .SH NAME
  5. lGetIndxNode - Get node by index.
  6. .SH SYNOPSIS
  7. int
  8. .BR "lGetIndxNode" "(id, index, data, size)"
  9. .br
  10. .RT
  11. .RP
  12. In    int    id    identifier of linked list
  13. .RP
  14. In    int    index    index of node which must be retrieved
  15. .RP
  16. Out    Byte    *data    data of node
  17. .RP
  18. In    int    size    size of data
  19. .DT
  20. .SH DESCRIPTION
  21. \fBlGetIndxNode\fP gets the data of an indexed node of a linked list. Which
  22. node must be retrieved can be specified by \fIindex\fP (\(>= 1).
  23. .br
  24. When the retrieved node is the first or the last node, the return code
  25. will have the value lFIRST or lLAST. For the other nodes the routine returns
  26. lSUCCESS.
  27. .SH RETURN CODES
  28. .nf
  29. Return on success :
  30.     lSUCCESS, lFIRST, lLAST
  31. Return on error :
  32.     lUNKNOWN_ID, lEMPTY_LIST, lWRONG_INDEX, lSIZE_NE
  33. .fi
  34. .SH AUTHOR
  35. Anita Eijs (TNO - Bouw - BouwInformatica)
  36.